GitHub Weekly Reporter

Your GitHub activity, turned into a beautiful weekly report. Automatically.

demo.mp4

Every week, this tool looks at everything you did on GitHub (commits, pull requests, code reviews) and generates a polished, shareable report page with AI-written summaries. It runs as a GitHub Action, deploys to GitHub Pages, and costs nothing.

What You Need

Have these two things ready before running setup:

1. GitHub personal access token (PAT), either type works:

   • Fine-grained PAT (recommended): All repositories access with permissions: Actions, Administration, Contents, Pages, Secrets, Workflows (all Read & Write). (Create one)
   • Classic PAT: scopes repo and workflow. (Create one) Use this if you hit 403 errors with fine-grained tokens (e.g. org policy restrictions).

2. LLM API key from any supported provider:

   Provider	Free Tier	Get API Key
   OpenRouter	Yes (25+ free models)	https://openrouter.ai/settings/keys
   Groq	Yes (generous limits)	https://console.groq.com/keys
   Google Gemini	Yes	https://aistudio.google.com/apikey
   OpenAI	No	https://platform.openai.com/api-keys
   Anthropic	No	https://console.anthropic.com/settings/keys
   Grok (xAI)	No	https://console.x.ai

   You also need a model name. Find available models on your provider's page: OpenRouter, Groq, Gemini, OpenAI, Anthropic, Grok

Quick Start

npx github-weekly-reporter setup

The setup command walks you through everything interactively:

1. Creates a repository for your reports
2. Adds workflow files (daily fetch + weekly report)
3. Stores secrets (PAT and LLM API key)
4. Enables GitHub Pages
5. Triggers your first report

Your first report will be live within 5 minutes.

See Manual Setup if you prefer to configure everything yourself.

Cost

The entire stack runs at $0/month on a public repository.

Component	Cost	Details
GitHub Actions	Free	~80 min/month (30 daily runs + 4 weekly runs). Public repos have unlimited free minutes.
LLM	Free	One API call per week. OpenRouter, Groq, and Gemini all offer free tiers.
GitHub Pages	Free	Hosting and deployment included for public repos.
npm package	Free	Runs via npx, no installation required.

On paid LLM providers (OpenAI, Anthropic, Grok), the cost is roughly $0.10-0.35/month (one call per week, ~4-8K tokens each).

Private repositories work too. GitHub Free gives 2,000 Actions minutes/month (this tool uses ~4% of that), but GitHub Pages on private repos requires a paid GitHub plan.

Themes

Three built-in themes, each with light/dark mode and responsive design.

Theme	Screenshot	Description
brutalist (default)		Bold, high-contrast dark theme with monospace typography. Example
minimal		Clean lines, generous whitespace, understated elegance. Example
editorial		Horizontal-scroll magazine with serif typography and column layout. Example

Set the theme in your workflow or during setup:

with:
  theme: 'editorial'

Profile Card

Embed an animated news ticker in your GitHub Profile README. AI-generated headlines scroll with dramatic labels.

Generated automatically as part of the render command. Add this to your profile README:

<a href="https://github.com/{username}/{repo}">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://{username}.github.io/{repo}/card-dark.svg" />
    <source media="(prefers-color-scheme: light)" srcset="https://{username}.github.io/{repo}/card.svg" />
    <img alt="Weekly Report" src="https://{username}.github.io/{repo}/card.svg" height="48" />
  </picture>
</a>

Features

• Weekly stats: commits, PRs opened/merged, reviews
• Top repositories by activity
• Language breakdown (CSS-only chart)
• 7-day contribution heatmap
• AI-generated narrative summary
• Light/dark mode with responsive design
• Self-contained HTML, no JavaScript
• SEO optimized (OG images, JSON-LD, sitemap)
• Deploys to GitHub Pages with weekly archive
• 10 languages supported

Supported Languages

Code	Language
en	English
ja	Japanese
zh-CN	Chinese (Simplified)
zh-TW	Chinese (Traditional)
ko	Korean
es	Spanish
fr	French
de	German
pt	Portuguese
ru	Russian

Documentation

• How It Works: the pipeline, data flow, and what gets collected
• Manual Setup: step-by-step guide without the setup command
• Customization: change language, timezone, LLM provider, custom domain, and more
• CLI Reference: all commands and environment variables
• FAQ: common questions about cost, privacy, and limitations
• Troubleshooting: fixing workflow failures, missing data, and setup errors

License

See LICENSE for details.

• Commercial use: "Powered by deariary" footer link must be retained
• Personal/non-commercial use: footer link may be removed
• Derivative works: same conditions apply